/*
 * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

package com.amazonaws.services.comprehend.model;

import java.io.Serializable;

import com.amazonaws.AmazonWebServiceRequest;

/**
 * <p>
 * Attaches a resource-based policy to a custom model. You can use this policy
 * to authorize an entity in another Amazon Web Services account to import the
 * custom model, which replicates it in Amazon Comprehend in their account.
 * </p>
 */
public class PutResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable {
    /**
     * <p>
     * The Amazon Resource Name (ARN) of the custom model to attach the policy
     * to.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b> - 256<br/>
     * <b>Pattern:
     * </b>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document
     * -classifier
     * |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-
     * Z0-9](-*[a-zA-Z0-9])*)?<br/>
     */
    private String resourceArn;

    /**
     * <p>
     * The JSON resource-based policy to attach to your custom model. Provide
     * your JSON as a UTF-8 encoded string without line breaks. To provide valid
     * JSON for your policy, enclose the attribute names and values in double
     * quotes. If the JSON body is also enclosed in double quotes, then you must
     * escape the double quotes that are inside the policy:
     * </p>
     * <p>
     * <code>"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"</code>
     * </p>
     * <p>
     * To avoid escaping quotes, you can use single quotes to enclose the policy
     * and double quotes to enclose the JSON names and values:
     * </p>
     * <p>
     * <code>'{"attribute": "value", "attribute": ["value"]}'</code>
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b>1 - 20000<br/>
     * <b>Pattern: </b>[ -\u00FF]+<br/>
     */
    private String resourcePolicy;

    /**
     * <p>
     * The revision ID that Amazon Comprehend assigned to the policy that you
     * are updating. If you are creating a new policy that has no prior version,
     * don't use this parameter. Amazon Comprehend creates the revision ID for
     * you.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b> - 64<br/>
     * <b>Pattern: </b>[0-9A-Fa-f]+<br/>
     */
    private String policyRevisionId;

    /**
     * <p>
     * The Amazon Resource Name (ARN) of the custom model to attach the policy
     * to.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b> - 256<br/>
     * <b>Pattern:
     * </b>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document
     * -classifier
     * |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-
     * Z0-9](-*[a-zA-Z0-9])*)?<br/>
     *
     * @return <p>
     *         The Amazon Resource Name (ARN) of the custom model to attach the
     *         policy to.
     *         </p>
     */
    public String getResourceArn() {
        return resourceArn;
    }

    /**
     * <p>
     * The Amazon Resource Name (ARN) of the custom model to attach the policy
     * to.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b> - 256<br/>
     * <b>Pattern:
     * </b>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document
     * -classifier
     * |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-
     * Z0-9](-*[a-zA-Z0-9])*)?<br/>
     *
     * @param resourceArn <p>
     *            The Amazon Resource Name (ARN) of the custom model to attach
     *            the policy to.
     *            </p>
     */
    public void setResourceArn(String resourceArn) {
        this.resourceArn = resourceArn;
    }

    /**
     * <p>
     * The Amazon Resource Name (ARN) of the custom model to attach the policy
     * to.
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b> - 256<br/>
     * <b>Pattern:
     * </b>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document
     * -classifier
     * |entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-
     * Z0-9](-*[a-zA-Z0-9])*)?<br/>
     *
     * @param resourceArn <p>
     *            The Amazon Resource Name (ARN) of the custom model to attach
     *            the policy to.
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public PutResourcePolicyRequest withResourceArn(String resourceArn) {
        this.resourceArn = resourceArn;
        return this;
    }

    /**
     * <p>
     * The JSON resource-based policy to attach to your custom model. Provide
     * your JSON as a UTF-8 encoded string without line breaks. To provide valid
     * JSON for your policy, enclose the attribute names and values in double
     * quotes. If the JSON body is also enclosed in double quotes, then you must
     * escape the double quotes that are inside the policy:
     * </p>
     * <p>
     * <code>"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"</code>
     * </p>
     * <p>
     * To avoid escaping quotes, you can use single quotes to enclose the policy
     * and double quotes to enclose the JSON names and values:
     * </p>
     * <p>
     * <code>'{"attribute": "value", "attribute": ["value"]}'</code>
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b>1 - 20000<br/>
     * <b>Pattern: </b>[ -\u00FF]+<br/>
     *
     * @return <p>
     *         The JSON resource-based policy to attach to your custom model.
     *         Provide your JSON as a UTF-8 encoded string without line breaks.
     *         To provide valid JSON for your policy, enclose the attribute
     *         names and values in double quotes. If the JSON body is also
     *         enclosed in double quotes, then you must escape the double quotes
     *         that are inside the policy:
     *         </p>
     *         <p>
     *         <code>"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"</code>
     *         </p>
     *         <p>
     *         To avoid escaping quotes, you can use single quotes to enclose
     *         the policy and double quotes to enclose the JSON names and
     *         values:
     *         </p>
     *         <p>
     *         <code>'{"attribute": "value", "attribute": ["value"]}'</code>
     *         </p>
     */
    public String getResourcePolicy() {
        return resourcePolicy;
    }

    /**
     * <p>
     * The JSON resource-based policy to attach to your custom model. Provide
     * your JSON as a UTF-8 encoded string without line breaks. To provide valid
     * JSON for your policy, enclose the attribute names and values in double
     * quotes. If the JSON body is also enclosed in double quotes, then you must
     * escape the double quotes that are inside the policy:
     * </p>
     * <p>
     * <code>"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"</code>
     * </p>
     * <p>
     * To avoid escaping quotes, you can use single quotes to enclose the policy
     * and double quotes to enclose the JSON names and values:
     * </p>
     * <p>
     * <code>'{"attribute": "value", "attribute": ["value"]}'</code>
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b>1 - 20000<br/>
     * <b>Pattern: </b>[ -\u00FF]+<br/>
     *
     * @param resourcePolicy <p>
     *            The JSON resource-based policy to attach to your custom model.
     *            Provide your JSON as a UTF-8 encoded string without line
     *            breaks. To provide valid JSON for your policy, enclose the
     *            attribute names and values in double quotes. If the JSON body
     *            is also enclosed in double quotes, then you must escape the
     *            double quotes that are inside the policy:
     *            </p>
     *            <p>
     *            <code>"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"</code>
     *            </p>
     *            <p>
     *            To avoid escaping quotes, you can use single quotes to enclose
     *            the policy and double quotes to enclose the JSON names and
     *            values:
     *            </p>
     *            <p>
     *            <code>'{"attribute": "value", "attribute": ["value"]}'</code>
     *            </p>
     */
    public void setResourcePolicy(String resourcePolicy) {
        this.resourcePolicy = resourcePolicy;
    }

    /**
     * <p>
     * The JSON resource-based policy to attach to your custom model. Provide
     * your JSON as a UTF-8 encoded string without line breaks. To provide valid
     * JSON for your policy, enclose the attribute names and values in double
     * quotes. If the JSON body is also enclosed in double quotes, then you must
     * escape the double quotes that are inside the policy:
     * </p>
     * <p>
     * <code>"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"</code>
     * </p>
     * <p>
     * To avoid escaping quotes, you can use single quotes to enclose the policy
     * and double quotes to enclose the JSON names and values:
     * </p>
     * <p>
     * <code>'{"attribute": "value", "attribute": ["value"]}'</code>
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b>1 - 20000<br/>
     * <b>Pattern: </b>[ -\u00FF]+<br/>
     *
     * @param resourcePolicy <p>
     *            The JSON resource-based policy to attach to your custom model.
     *            Provide your JSON as a UTF-8 encoded string without line
     *            breaks. To provide valid JSON for your policy, enclose the
     *            attribute names and values in double quotes. If the JSON body
     *            is also enclosed in double quotes, then you must escape the
     *            double quotes that are inside the policy:
     *            </p>
     *            <p>
     *            <code>"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"</code>
     *            </p>
     *            <p>
     *            To avoid escaping quotes, you can use single quotes to enclose
     *            the policy and double quotes to enclose the JSON names and
     *            values:
     *            </p>
     *            <p>
     *            <code>'{"attribute": "value", "attribute": ["value"]}'</code>
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public PutResourcePolicyRequest withResourcePolicy(String resourcePolicy) {
        this.resourcePolicy = resourcePolicy;
        return this;
    }

    /**
     * <p>
     * The revision ID that Amazon Comprehend assigned to the policy that you
     * are updating. If you are creating a new policy that has no prior version,
     * don't use this parameter. Amazon Comprehend creates the revision ID for
     * you.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b> - 64<br/>
     * <b>Pattern: </b>[0-9A-Fa-f]+<br/>
     *
     * @return <p>
     *         The revision ID that Amazon Comprehend assigned to the policy
     *         that you are updating. If you are creating a new policy that has
     *         no prior version, don't use this parameter. Amazon Comprehend
     *         creates the revision ID for you.
     *         </p>
     */
    public String getPolicyRevisionId() {
        return policyRevisionId;
    }

    /**
     * <p>
     * The revision ID that Amazon Comprehend assigned to the policy that you
     * are updating. If you are creating a new policy that has no prior version,
     * don't use this parameter. Amazon Comprehend creates the revision ID for
     * you.
     * </p>
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b> - 64<br/>
     * <b>Pattern: </b>[0-9A-Fa-f]+<br/>
     *
     * @param policyRevisionId <p>
     *            The revision ID that Amazon Comprehend assigned to the policy
     *            that you are updating. If you are creating a new policy that
     *            has no prior version, don't use this parameter. Amazon
     *            Comprehend creates the revision ID for you.
     *            </p>
     */
    public void setPolicyRevisionId(String policyRevisionId) {
        this.policyRevisionId = policyRevisionId;
    }

    /**
     * <p>
     * The revision ID that Amazon Comprehend assigned to the policy that you
     * are updating. If you are creating a new policy that has no prior version,
     * don't use this parameter. Amazon Comprehend creates the revision ID for
     * you.
     * </p>
     * <p>
     * Returns a reference to this object so that method calls can be chained
     * together.
     * <p>
     * <b>Constraints:</b><br/>
     * <b>Length: </b> - 64<br/>
     * <b>Pattern: </b>[0-9A-Fa-f]+<br/>
     *
     * @param policyRevisionId <p>
     *            The revision ID that Amazon Comprehend assigned to the policy
     *            that you are updating. If you are creating a new policy that
     *            has no prior version, don't use this parameter. Amazon
     *            Comprehend creates the revision ID for you.
     *            </p>
     * @return A reference to this updated object so that method calls can be
     *         chained together.
     */
    public PutResourcePolicyRequest withPolicyRevisionId(String policyRevisionId) {
        this.policyRevisionId = policyRevisionId;
        return this;
    }

    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getResourceArn() != null)
            sb.append("ResourceArn: " + getResourceArn() + ",");
        if (getResourcePolicy() != null)
            sb.append("ResourcePolicy: " + getResourcePolicy() + ",");
        if (getPolicyRevisionId() != null)
            sb.append("PolicyRevisionId: " + getPolicyRevisionId());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode
                + ((getResourceArn() == null) ? 0 : getResourceArn().hashCode());
        hashCode = prime * hashCode
                + ((getResourcePolicy() == null) ? 0 : getResourcePolicy().hashCode());
        hashCode = prime * hashCode
                + ((getPolicyRevisionId() == null) ? 0 : getPolicyRevisionId().hashCode());
        return hashCode;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof PutResourcePolicyRequest == false)
            return false;
        PutResourcePolicyRequest other = (PutResourcePolicyRequest) obj;

        if (other.getResourceArn() == null ^ this.getResourceArn() == null)
            return false;
        if (other.getResourceArn() != null
                && other.getResourceArn().equals(this.getResourceArn()) == false)
            return false;
        if (other.getResourcePolicy() == null ^ this.getResourcePolicy() == null)
            return false;
        if (other.getResourcePolicy() != null
                && other.getResourcePolicy().equals(this.getResourcePolicy()) == false)
            return false;
        if (other.getPolicyRevisionId() == null ^ this.getPolicyRevisionId() == null)
            return false;
        if (other.getPolicyRevisionId() != null
                && other.getPolicyRevisionId().equals(this.getPolicyRevisionId()) == false)
            return false;
        return true;
    }
}
